Cisco-IOS-XR-ethernet-link-oam-cfg API API Reference
API generated from Cisco-IOS-XR-ethernet-link-oam-cfg@2015-11-09.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
VIEWS - Update
Update operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Request Content-Types: application/json
Request Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
LOGGING - Update
Update operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}, {
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
AGENT - Update
Update operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Request Content-Types: application/json
Request Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Request Content-Types: application/json
Request Example
{
"unknown-user": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"unknown-user": [ null ]
}
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Request Content-Types: application/json
Request Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
TARGET - Update
Update operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
TARGETS - Update
Update operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string"
}
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Request Content-Types: application/json
Request Example
{
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ip-address": "string"
}
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}, "enable": [ null ]
}, "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}, "enable": [ null ]
}, "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}, "enable": [ null ]
}, "authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}, "vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
VPLS - Update
Update operation of resource: vpls
vplsbody object
Request Content-Types: application/json
Request Example
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Create
Create operation of resource: vpls
vplsbody object
Request Content-Types: application/json
Request Example
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Delete
Delete operation of resource: vpls
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Retrieve
Retrieve operation of resource: vpls
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
L2VPN - Update
Update operation of resource: l2vpn
l2vpnbody object
Request Content-Types: application/json
Request Example
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Create
Create operation of resource: l2vpn
l2vpnbody object
Request Content-Types: application/json
Request Example
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Delete
Delete operation of resource: l2vpn
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Retrieve
Retrieve operation of resource: l2vpn
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
OAM - Update
Update operation of resource: oam
oambody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Create
Create operation of resource: oam
oambody object
Request Content-Types: application/json
Request Example
{
"enable": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Delete
Delete operation of resource: oam
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Retrieve
Retrieve operation of resource: oam
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"enable": [ null ]
}
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}, {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer", {
"oid": "string",
"created": [ null ], {
"oid": "string", "index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string", "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Request Content-Types: application/json
Request Example
{
"index": "string",
"value": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"index": "string",
"value": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string", {
"rulename": "string"
}
]
}, "all": [ null ], {
"port": "string",
"ip-address": "string"
}
]
}
}
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
Successful operation
Internal Error
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Request Content-Types: application/json
Request Example
{
"rulename": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"rulename": "string"
}
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Request Content-Types: application/json
Request Example
{
"port": "string",
"ip-address": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"ip-address": "string"
}
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"memory": "integer", {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}, {
"object-list-name": "string", {
"oid": "string"
}
]
},
"type": [ null ]
}
]
}, {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string", "end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Request Content-Types: application/json
Request Example
{
"oid": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"oid": "string"
}
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"retry": "integer", {
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Request Content-Types: application/json
Request Example
{
"schema-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"schema-name": "string"
}
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Request Content-Types: application/json
Request Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"drop-time": "integer",
"throttle-rate": "integer"
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", {
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string", {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}, {
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
Successful operation
Internal Error
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Request Content-Types: application/json
Request Example
{
"context-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-name": "string"
}
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
ETHERNET-FEATURES - Update
Update operation of resource: ethernet-features
ethernet-featuresbody object
Request Content-Types: application/json
Request Example
{ "egress-filtering-default-on": [ null ]
}, {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Create
Create operation of resource: ethernet-features
ethernet-featuresbody object
Request Content-Types: application/json
Request Example
{ "egress-filtering-default-on": [ null ]
}, {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Delete
Delete operation of resource: ethernet-features
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: ethernet-features
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "egress-filtering-default-on": [ null ]
}, {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
}
EGRESS-FILTERING - Update
Update operation of resource: egress-filtering
egress-filteringbody object
Request Content-Types: application/json
Request Example
{
"egress-filtering-default-on": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Create
Create operation of resource: egress-filtering
egress-filteringbody object
Request Content-Types: application/json
Request Example
{
"egress-filtering-default-on": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Delete
Delete operation of resource: egress-filtering
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Retrieve
Retrieve operation of resource: egress-filtering
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"egress-filtering-default-on": [ null ]
}
ETHER-LINK-OAM - Update
Update operation of resource: ether-link-oam
ether-link-oambody object
Request Content-Types: application/json
Request Example
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Create
Create operation of resource: ether-link-oam
ether-link-oambody object
Request Content-Types: application/json
Request Example
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Delete
Delete operation of resource: ether-link-oam
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Retrieve
Retrieve operation of resource: ether-link-oam
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
PROFILES - Update
Update operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Create
Create operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Delete
Delete operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Retrieve
Retrieve operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile
Request Content-Types: application/json
Request Example
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile
Request Content-Types: application/json
Request Example
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
ACTION - Update
Update operation of resource: action
actionbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Create
Create operation of resource: action
actionbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Delete
Delete operation of resource: action
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Retrieve
Retrieve operation of resource: action
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}
REQUIRE-REMOTE - Update
Update operation of resource: require-remote
require-remotebody object
ID of profile
Request Content-Types: application/json
Request Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Create
Create operation of resource: require-remote
require-remotebody object
ID of profile
Request Content-Types: application/json
Request Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Delete
Delete operation of resource: require-remote
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Retrieve
Retrieve operation of resource: require-remote
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
LINK-MONITORING - Update
Update operation of resource: link-monitoring
link-monitoringbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Create
Create operation of resource: link-monitoring
link-monitoringbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Delete
Delete operation of resource: link-monitoring
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Retrieve
Retrieve operation of resource: link-monitoring
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
SYMBOL-PERIOD - Update
Update operation of resource: symbol-period
symbol-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Create
Create operation of resource: symbol-period
symbol-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Delete
Delete operation of resource: symbol-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Retrieve
Retrieve operation of resource: symbol-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME-PERIOD - Update
Update operation of resource: frame-period
frame-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Create
Create operation of resource: frame-period
frame-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Delete
Delete operation of resource: frame-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Retrieve
Retrieve operation of resource: frame-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME-SECONDS - Update
Update operation of resource: frame-seconds
frame-secondsbody object
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Create
Create operation of resource: frame-seconds
frame-secondsbody object
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Delete
Delete operation of resource: frame-seconds
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Retrieve
Retrieve operation of resource: frame-seconds
ID of profile
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME - Update
Update operation of resource: frame
framebody object
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Create
Create operation of resource: frame
framebody object
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Delete
Delete operation of resource: frame
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Retrieve
Retrieve operation of resource: frame
ID of profile
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
GLOBAL-INTERFACE-CONFIGURATION - Update
Update operation of resource: global-interface-configuration
global-interface-configurationbody object
Request Content-Types: application/json
Request Example
{
"link-status": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Create
Create operation of resource: global-interface-configuration
global-interface-configurationbody object
Request Content-Types: application/json
Request Example
{
"link-status": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Delete
Delete operation of resource: global-interface-configuration
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: global-interface-configuration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"link-status": "string"
}
INTERFACE-CONFIGURATIONS - Update
Update operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], }
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Create
Create operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], }
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Delete
Delete operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Retrieve
Retrieve operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], }
}
]
}
INTERFACE-CONFIGURATION - Update
Update operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], {}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Create
Create operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], {}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Delete
Delete operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ], "ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer", "ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ], "vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string", "encapsulation": "string",
"capsulation-options": "integer"
}, "host-routing": [ null ]
}, "carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}, "vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}, "propagate-remote-status": [ null ], {}
]
}
}
}
DAMPENING - Update
Update operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Create
Create operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Delete
Delete operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Retrieve
Retrieve operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
MTUS - Update
Update operation of resource: mtus
mtusbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Create
Create operation of resource: mtus
mtusbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Delete
Delete operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Retrieve
Retrieve operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
MTU - Update
Update operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Request Content-Types: application/json
Request Example
{
"owner": "string",
"mtu": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Create
Create operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Request Content-Types: application/json
Request Example
{
"owner": "string",
"mtu": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Delete
Delete operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Retrieve
Retrieve operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"owner": "string",
"mtu": "integer"
}
ENCAPSULATION - Update
Update operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Create
Create operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Delete
Delete operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Retrieve
Retrieve operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
PSEUDOWIRE-ETHER - Update
Update operation of resource: pseudowire-ether
pseudowire-etherbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"l2-overhead": "integer",
"generic-interface-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Create
Create operation of resource: pseudowire-ether
pseudowire-etherbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"l2-overhead": "integer",
"generic-interface-list": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Delete
Delete operation of resource: pseudowire-ether
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Retrieve
Retrieve operation of resource: pseudowire-ether
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"l2-overhead": "integer",
"generic-interface-list": "string"
}
PSEUDOWIRE-IW - Update
Update operation of resource: pseudowire-iw
pseudowire-iwbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"generic-interface-list": "string",
"l2-overhead": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Create
Create operation of resource: pseudowire-iw
pseudowire-iwbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"generic-interface-list": "string",
"l2-overhead": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Delete
Delete operation of resource: pseudowire-iw
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Retrieve
Retrieve operation of resource: pseudowire-iw
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"generic-interface-list": "string",
"l2-overhead": "integer"
}
BVI - Update
Update operation of resource: bvi
bvibody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"host-routing": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Create
Create operation of resource: bvi
bvibody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"host-routing": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Delete
Delete operation of resource: bvi
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Retrieve
Retrieve operation of resource: bvi
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"host-routing": [ null ]
}
L2-TRANSPORT - Update
Update operation of resource: l2-transport
l2-transportbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"propagate-remote-status": [ null ], {
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
]
},
"enabled": [ null ], "egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Create
Create operation of resource: l2-transport
l2-transportbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"propagate-remote-status": [ null ], {
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
]
},
"enabled": [ null ], "egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Delete
Delete operation of resource: l2-transport
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Retrieve
Retrieve operation of resource: l2-transport
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"propagate-remote-status": [ null ], {
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
]
},
"enabled": [ null ], "egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
}
L2-PROTOCOLS - Update
Update operation of resource: l2-protocols
l2-protocolsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Create
Create operation of resource: l2-protocols
l2-protocolsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Delete
Delete operation of resource: l2-protocols
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Retrieve
Retrieve operation of resource: l2-protocols
ID of active interface-name
Successful operation
Internal Error
L2-PROTOCOL - Update
Update operation of resource: l2-protocol
l2-protocolbody object
ID of active interface-name
ID of l2-protocol-name
Request Content-Types: application/json
Request Example
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Create
Create operation of resource: l2-protocol
l2-protocolbody object
ID of active interface-name
ID of l2-protocol-name
Request Content-Types: application/json
Request Example
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Delete
Delete operation of resource: l2-protocol
ID of active interface-name
ID of l2-protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Retrieve
Retrieve operation of resource: l2-protocol
ID of active interface-name
ID of l2-protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
L2-ETHERNET-FEATURES - Update
Update operation of resource: l2-ethernet-features
l2-ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Create
Create operation of resource: l2-ethernet-features
l2-ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Delete
Delete operation of resource: l2-ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: l2-ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
VLAN-SUB-CONFIGURATION - Update
Update operation of resource: vlan-sub-configuration
vlan-sub-configurationbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Create
Create operation of resource: vlan-sub-configuration
vlan-sub-configurationbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Delete
Delete operation of resource: vlan-sub-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Retrieve
Retrieve operation of resource: vlan-sub-configuration
ID of active interface-name
Successful operation
Internal Error
VLAN-IDENTIFIER - Update
Update operation of resource: vlan-identifier
vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Create
Create operation of resource: vlan-identifier
vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Delete
Delete operation of resource: vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Retrieve
Retrieve operation of resource: vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
ETHERNET-SERVICE - Update
Update operation of resource: ethernet-service
ethernet-servicebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}, "inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}, "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Create
Create operation of resource: ethernet-service
ethernet-servicebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}, "inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}, "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Delete
Delete operation of resource: ethernet-service
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Retrieve
Retrieve operation of resource: ethernet-service
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}, "inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}, "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Update
Update operation of resource: local-traffic-default-encapsulation
local-traffic-default-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Create
Create operation of resource: local-traffic-default-encapsulation
local-traffic-default-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Delete
Delete operation of resource: local-traffic-default-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Retrieve
Retrieve operation of resource: local-traffic-default-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}
ENCAPSULATION - Update
Update operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Create
Create operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Delete
Delete operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Retrieve
Retrieve operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
REWRITE - Update
Update operation of resource: rewrite
rewritebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Create
Create operation of resource: rewrite
rewritebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Delete
Delete operation of resource: rewrite
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Retrieve
Retrieve operation of resource: rewrite
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}
ETHERNET-BNG - Update
Update operation of resource: ethernet-bng
ethernet-bngbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Create
Create operation of resource: ethernet-bng
ethernet-bngbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Delete
Delete operation of resource: ethernet-bng
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Retrieve
Retrieve operation of resource: ethernet-bng
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
AMBIGUOUS-ENCAPSULATION - Update
Update operation of resource: ambiguous-encapsulation
ambiguous-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Create
Create operation of resource: ambiguous-encapsulation
ambiguous-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Delete
Delete operation of resource: ambiguous-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Retrieve
Retrieve operation of resource: ambiguous-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
MAC-ACCOUNTING - Update
Update operation of resource: mac-accounting
mac-accountingbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress": [ null ],
"egress": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Create
Create operation of resource: mac-accounting
mac-accountingbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ingress": [ null ],
"egress": [ null ]
}
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Delete
Delete operation of resource: mac-accounting
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Retrieve
Retrieve operation of resource: mac-accounting
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ingress": [ null ],
"egress": [ null ]
}
ETHERNET-FEATURES - Update
Update operation of resource: ethernet-features
ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Create
Create operation of resource: ethernet-features
ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Delete
Delete operation of resource: ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ether-link-oam-enable": [ null ], "udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
}
ETHER-LINK-OAM - Update
Update operation of resource: ether-link-oam
ether-link-oambody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Create
Create operation of resource: ether-link-oam
ether-link-oambody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Delete
Delete operation of resource: ether-link-oam
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Retrieve
Retrieve operation of resource: ether-link-oam
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer", "dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}, "mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string", "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
ACTION - Update
Update operation of resource: action
actionbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Create
Create operation of resource: action
actionbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Delete
Delete operation of resource: action
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Retrieve
Retrieve operation of resource: action
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}
REQUIRE-REMOTE - Update
Update operation of resource: require-remote
require-remotebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Create
Create operation of resource: require-remote
require-remotebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Delete
Delete operation of resource: require-remote
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Retrieve
Retrieve operation of resource: require-remote
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
LINK-MONITORING - Update
Update operation of resource: link-monitoring
link-monitoringbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Create
Create operation of resource: link-monitoring
link-monitoringbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Delete
Delete operation of resource: link-monitoring
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Retrieve
Retrieve operation of resource: link-monitoring
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean", "threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}, "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
SYMBOL-PERIOD - Update
Update operation of resource: symbol-period
symbol-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Create
Create operation of resource: symbol-period
symbol-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Delete
Delete operation of resource: symbol-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Retrieve
Retrieve operation of resource: symbol-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME-PERIOD - Update
Update operation of resource: frame-period
frame-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Create
Create operation of resource: frame-period
frame-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Delete
Delete operation of resource: frame-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Retrieve
Retrieve operation of resource: frame-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}, "units": "string",
"window": "integer",
"multiplier": "string"
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME-SECONDS - Update
Update operation of resource: frame-seconds
frame-secondsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Create
Create operation of resource: frame-seconds
frame-secondsbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Delete
Delete operation of resource: frame-seconds
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Retrieve
Retrieve operation of resource: frame-seconds
ID of active interface-name
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
FRAME - Update
Update operation of resource: frame
framebody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Create
Create operation of resource: frame
framebody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Delete
Delete operation of resource: frame
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Retrieve
Retrieve operation of resource: frame
ID of active interface-name
Successful operation
Internal Error
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
CARRIER-DELAY - Update
Update operation of resource: carrier-delay
carrier-delaybody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Create
Create operation of resource: carrier-delay
carrier-delaybody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Delete
Delete operation of resource: carrier-delay
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Retrieve
Retrieve operation of resource: carrier-delay
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}
VLAN-TRUNK-CONFIGURATION - Update
Update operation of resource: vlan-trunk-configuration
vlan-trunk-configurationbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Create
Create operation of resource: vlan-trunk-configuration
vlan-trunk-configurationbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Delete
Delete operation of resource: vlan-trunk-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Retrieve
Retrieve operation of resource: vlan-trunk-configuration
ID of active interface-name
Successful operation
Internal Error
NATIVE-VLAN-IDENTIFIER - Update
Update operation of resource: native-vlan-identifier
native-vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"vlan-type": "string",
"vlan-identifier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Create
Create operation of resource: native-vlan-identifier
native-vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{
"vlan-type": "string",
"vlan-identifier": "string"
}
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Delete
Delete operation of resource: native-vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Retrieve
Retrieve operation of resource: native-vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vlan-type": "string",
"vlan-identifier": "string"
}
Schema Definitions
LINK-MONITORING:
Common node of profile, ether-link-oam
- link-monitoring: object
-
Configure link monitor parameters
-
- frame-seconds: object
-
Frame-seconds event configuration
-
- threshold: object
-
Threshold configuration for frame-seconds events
-
- threshold-high: integer
-
The high threshold for frame-seconds events
range:"1..4294967295" units:"second" - threshold-low: integer
-
The low threshold for frame-seconds events
range:"1..4294967295" units:"second" default:"1"
- window: integer
-
Window size configuration for frame-seconds events
range:"1000..60000" units:"millisecond" default:"60000"
- symbol-period: object
-
Symbol-period event configuration
-
- threshold: object
-
Threshold configuration for symbol-period events
-
- threshold-high: integer
-
The high threshold for symbol-period
range:"1..4294967295" units:"second" - units: string symbols, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for symbol-period
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- window: object
-
Window size configuration for symbol-period events
-
- units: string milliseconds, symbols
-
Units to use for this window
- window: integer
-
Size of the symbol-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- monitoring: boolean
-
Enable or disable monitoring
default: - frame: object
-
Frame event configuration
-
- threshold: object
-
Threshold configuration for frame events
-
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
- window: integer
-
Window size configuration for frame events
range:"1000..60000" units:"millisecond" default:"60000"
- frame-period: object
-
Frame-period event configuration
-
- threshold: object
-
Threshold configuration for frame-period events
-
- threshold-high: integer
-
The high threshold for frame-period events
range:"1..4294967295" units:"second" - units: string frames, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame-period events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- window: object
-
Window size configuration for frame-period events
-
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
TRAP-HOST-TABLE:
Common node of snmp, vrf
- trap-hosts: object
-
Specify hosts to receive SNMP notifications
-
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-hosts": {
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
}
APPLIED-TO:
Common node of rule, rule-set
- applied-to: object
-
Applied to the Rule or Ruleset
-
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
CONTEXT-MAPPING-TABLE:
Common node of snmp, vrf
- context-mappings: object
-
List of context names
-
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
VAR-BIND-TABLE:
Common node of root-cause, non-root-cause
- var-binds: object
-
Varbinds to match
-
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
CONTEXT-TABLE:
Common node of snmp, vrf
- contexts: object
-
List of Context Names
-
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"contexts": {
"context": [
{
"context-name": "string"
}
]
}
}
a1_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a1_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a1_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a1_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a1_threshold_schema:
SNMP logging threshold
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"oid-processing": "integer",
"pdu-processing": "integer"
}
a1_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a1_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a1_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a1_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a1_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a1_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a1_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a1_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a1_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a1_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a1_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a1_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a1_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a1_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a1_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a1_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a1_notification_schema:
Enable SNMP notifications
- vpls: object
-
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
-
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
- oam: object
-
802.3 OAM MIB notification configuration
-
- enable: null
-
Enable 802.3 OAM MIB notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
- l2vpn: object
-
CISCO-IETF-PW-MIB notification configuration
-
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vpls": {
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
},
"oam": {
"enable": [ null ]
},
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
},
"l2vpn": {
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
a1_vpls_schema:
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
Example
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
a1_l2vpn_schema:
CISCO-IETF-PW-MIB notification configuration
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
a1_oam_schema:
802.3 OAM MIB notification configuration
- enable: null
-
Enable 802.3 OAM MIB notifications
Example
{
"enable": [ null ]
}
a1_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a1_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a1_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a1_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a1_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a1_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a1_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a1_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a1_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a1_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a1_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a1_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a1_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a1_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a1_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a1_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a1_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a1_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a1_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a1_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a1_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a1_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a1_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a1_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a1_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a1_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a1_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a1_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a1_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a1_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a1_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a1_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a1_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a1_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a1_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a1_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a1_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a1_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
a2_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a2_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a2_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a2_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a2_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a2_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a2_threshold_schema:
Threshold configuration for frame events
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
a2_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a2_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a2_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a2_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a2_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a2_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a2_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a2_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a2_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a2_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a2_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a2_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a2_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a2_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a2_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a2_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a2_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a2_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a2_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a2_notification_schema:
Enable SNMP notifications
- vpls: object
-
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
-
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
- oam: object
-
802.3 OAM MIB notification configuration
-
- enable: null
-
Enable 802.3 OAM MIB notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
- l2vpn: object
-
CISCO-IETF-PW-MIB notification configuration
-
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vpls": {
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
},
"oam": {
"enable": [ null ]
},
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
},
"l2vpn": {
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
a2_vpls_schema:
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
Example
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
a2_l2vpn_schema:
CISCO-IETF-PW-MIB notification configuration
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
a2_oam_schema:
802.3 OAM MIB notification configuration
- enable: null
-
Enable 802.3 OAM MIB notifications
Example
{
"enable": [ null ]
}
a2_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a2_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a2_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a2_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a2_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a2_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a2_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a2_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a2_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a2_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a2_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a2_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a2_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a2_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a2_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a2_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a2_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a2_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a2_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a2_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a2_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a2_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a2_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a2_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a2_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a2_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a2_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a2_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a2_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a2_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a2_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a2_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a2_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a2_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a2_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a2_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a2_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a2_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a2_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a2_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a2_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a2_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a2_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
a2_ethernet-features_schema:
Ethernet Features Configuration
- egress-filtering: object
-
Egress Filtering Configuration
-
- egress-filtering-default-on: null
-
Whether Egress Filtering is on by default
- ether-link-oam: object
-
Ethernet Link OAM Global Configuration
-
- profiles: object
-
Table of Ethernet Link OAM profiles
-
- profile: object[]
-
Name of the profile
-
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"egress-filtering": {
"egress-filtering-default-on": [ null ]
},
"ether-link-oam": {
"profiles": {
"profile": [
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
}
a2_egress-filtering_schema:
Egress Filtering Configuration
- egress-filtering-default-on: null
-
Whether Egress Filtering is on by default
Example
{
"egress-filtering-default-on": [ null ]
}
a2_ether-link-oam_schema:
Ethernet Link OAM Global Configuration
- profiles: object
-
Table of Ethernet Link OAM profiles
-
- profile: object[]
-
Name of the profile
-
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"profiles": {
"profile": [
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
}
a2_profiles_schema:
Table of Ethernet Link OAM profiles
- profile: object[]
-
Name of the profile
-
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"profile": [
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
a2_profile_schema:
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
a2_action_schema:
Configure action parameters
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
}
a2_require-remote_schema:
Configure remote requirement parameters
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
a2_link-monitoring_schema:
Configure link monitor parameters
- frame-seconds: object
-
Frame-seconds event configuration
-
- threshold: object
-
Threshold configuration for frame-seconds events
-
- threshold-high: integer
-
The high threshold for frame-seconds events
range:"1..4294967295" units:"second" - threshold-low: integer
-
The low threshold for frame-seconds events
range:"1..4294967295" units:"second" default:"1"
- window: integer
-
Window size configuration for frame-seconds events
range:"1000..60000" units:"millisecond" default:"60000"
- symbol-period: object
-
Symbol-period event configuration
-
- threshold: object
-
Threshold configuration for symbol-period events
-
- threshold-high: integer
-
The high threshold for symbol-period
range:"1..4294967295" units:"second" - units: string symbols, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for symbol-period
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- window: object
-
Window size configuration for symbol-period events
-
- units: string milliseconds, symbols
-
Units to use for this window
- window: integer
-
Size of the symbol-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- monitoring: boolean
-
Enable or disable monitoring
- frame: object
-
Frame event configuration
-
- threshold: object
-
Threshold configuration for frame events
-
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
- window: integer
-
Window size configuration for frame events
range:"1000..60000" units:"millisecond" default:"60000"
- frame-period: object
-
Frame-period event configuration
-
- threshold: object
-
Threshold configuration for frame-period events
-
- threshold-high: integer
-
The high threshold for frame-period events
range:"1..4294967295" units:"second" - units: string frames, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame-period events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- window: object
-
Window size configuration for frame-period events
-
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
a2_symbol-period_schema:
Symbol-period event configuration
- threshold: object
-
Threshold configuration for symbol-period events
-
- threshold-high: integer
-
The high threshold for symbol-period
range:"1..4294967295" units:"second" - units: string symbols, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for symbol-period
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- window: object
-
Window size configuration for symbol-period events
-
- units: string milliseconds, symbols
-
Units to use for this window
- window: integer
-
Size of the symbol-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Symbols and treated as 1 if unspecified)
Example
{
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
a2_window_schema:
Window size configuration for frame-period events
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
a2_frame-period_schema:
Frame-period event configuration
- threshold: object
-
Threshold configuration for frame-period events
-
- threshold-high: integer
-
The high threshold for frame-period events
range:"1..4294967295" units:"second" - units: string frames, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame-period events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- window: object
-
Window size configuration for frame-period events
-
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
a2_frame-seconds_schema:
Frame-seconds event configuration
- threshold: object
-
Threshold configuration for frame-seconds events
-
- threshold-high: integer
-
The high threshold for frame-seconds events
range:"1..4294967295" units:"second" - threshold-low: integer
-
The low threshold for frame-seconds events
range:"1..4294967295" units:"second" default:"1"
- window: integer
-
Window size configuration for frame-seconds events
range:"1000..60000" units:"millisecond" default:"60000"
Example
{
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}
a2_frame_schema:
Frame event configuration
- threshold: object
-
Threshold configuration for frame events
-
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
- window: integer
-
Window size configuration for frame events
range:"1000..60000" units:"millisecond" default:"60000"
Example
{
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}
a3_snmp_schema:
SNMP notification configuration
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
Example
{
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
}
a3_encrypted-community-maps_schema:
Container class to hold clear/encrypted communitie maps
- encrypted-community-map: object[]
-
Clear/encrypted SNMP community map
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"encrypted-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a3_encrypted-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a3_views_schema:
Class to configure a SNMPv2 MIB view
- view: object[]
-
Name of the view
-
object - view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view": [
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
]
}
a3_view_schema:
- view-name: string
-
Name of the view
- view-inclusion: string included, excluded
-
MIB view to be included or excluded
- family: string
-
MIB view family name
Example
{
"view-name": "string",
"view-inclusion": "string",
"family": "string"
}
a3_logging_schema:
SNMP logging
- threshold: object
-
SNMP logging threshold
-
- oid-processing: integer
-
SNMP logging threshold for OID processing
range:"0..20000" default:"500" - pdu-processing: integer
-
SNMP logging threshold for PDU processing
range:"0..20000" default:"20000"
Example
{
"threshold": {
"oid-processing": "integer",
"pdu-processing": "integer"
}
}
a3_threshold_schema:
Threshold configuration for frame events
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
Example
{
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
}
a3_administration_schema:
Container class for SNMP administration
- default-communities: object
-
Container class to hold unencrpted communities
-
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- encrypted-communities: object
-
Container class to hold clear/encrypted communities
-
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-communities": {
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
},
"encrypted-communities": {
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
}
a3_default-communities_schema:
Container class to hold unencrpted communities
- default-community: object[]
-
Unencrpted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"default-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a3_default-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a3_encrypted-communities_schema:
Container class to hold clear/encrypted communities
- encrypted-community: object[]
-
Clear/encrypted SNMP community string and access priviledges
-
object - priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"encrypted-community": [
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
]
}
a3_encrypted-community_schema:
- priviledge: string read-only, read-write
-
Read/Write Access
- view-name: string
-
MIB view to which the community has access
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- community-name: string
-
SNMP community string
- owner: string sdr-owner, system-owner
-
Logical Router or System owner access
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
Example
{
"priviledge": "string",
"view-name": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"community-name": "string",
"owner": "string",
"v4acl-type": "string",
"v4-access-list": "string"
}
a3_agent_schema:
The heirarchy point for SNMP Agent configurations
- engine-id: object
-
SNMPv3 engineID
-
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"engine-id": {
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
}
a3_engine-id_schema:
SNMPv3 engineID
- remotes: object
-
SNMPv3 remote SNMP Entity
-
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- local: string
-
engineID of the local agent
Example
{
"remotes": {
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
},
"local": "string"
}
a3_remotes_schema:
SNMPv3 remote SNMP Entity
- remote: object[]
-
engineID of the remote agent
-
object - remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote": [
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
]
}
a3_remote_schema:
- remote-engine-id: string
-
engine ID octet string
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
Example
{
"remote-engine-id": "string",
"remote-address": "string",
"port": "string"
}
a3_trap_schema:
Class to hold trap configurations
- queue-length: integer
-
Message queue length for each TRAP host
range:"1..5000" - throttle-time: integer
-
Set throttle time for handling traps
range:"50..1000" units:"millisecond" - timeout: integer
-
Timeout for TRAP message retransmissions
range:"1..600000" units:"millisecond"
Example
{
"queue-length": "integer",
"throttle-time": "integer",
"timeout": "integer"
}
a3_drop-packet_schema:
SNMP packet drop config
- unknown-user: null
-
Enable drop unknown user name
Example
{
"unknown-user": [ null ]
}
a3_ipv6_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a3_tos_schema:
Type of TOS
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"type": "string",
"dscp": "string",
"precedence": "string"
}
a3_ipv4_schema:
SNMP TOS bit for outgoing packets
- tos: object
-
Type of TOS
-
- type: string precedence, dscp
-
SNMP TOS type DSCP or Precedence
- dscp: string
-
SNMP DSCP value
- precedence: string
-
SNMP Precedence value
Example
{
"tos": {
"type": "string",
"dscp": "string",
"precedence": "string"
}
}
a3_system_schema:
container to hold system information
- chassis-id: string
-
String to uniquely identify this chassis
- contact: string
-
identification of the contact person for this managed node
- location: string
-
The physical location of this node
Example
{
"chassis-id": "string",
"contact": "string",
"location": "string"
}
a3_target_schema:
- target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
a3_targets_schema:
List of targets
- target: object[]
-
Name of the target list
-
object - target-addresses: object
-
SNMP Target address configurations
-
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
- target-list-name: string
-
Name of the target list
- vrf-names: object
-
List of VRF Name for a target list
-
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"target": [
{
"target-addresses": {
"target-address": [
{
"ip-address": "string"
}
]
},
"target-list-name": "string",
"vrf-names": {
"vrf-name": [
{
"name": "string"
}
]
}
}
]
}
a3_vrf-names_schema:
List of VRF Name for a target list
- vrf-name: object[]
-
VRF name of the target
-
object - name: string
-
VRF Name
Example
{
"vrf-name": [
{
"name": "string"
}
]
}
a3_target-addresses_schema:
SNMP Target address configurations
- target-address: object[]
-
IP Address to be configured for the Target
-
object - ip-address: string
-
IPv4/Ipv6 address
Example
{
"target-address": [
{
"ip-address": "string"
}
]
}
a3_notification_schema:
Enable SNMP notifications
- vpls: object
-
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
-
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
- oam: object
-
802.3 OAM MIB notification configuration
-
- enable: null
-
Enable 802.3 OAM MIB notifications
- snmp: object
-
SNMP notification configuration
-
- authentication: null
-
Enable authentication notification
- enable: null
-
Enable SNMP notifications
- warm-start: null
-
Enable warm start notification
- cold-start: null
-
Enable cold start notification
- l2vpn: object
-
CISCO-IETF-PW-MIB notification configuration
-
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vpls": {
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
},
"oam": {
"enable": [ null ]
},
"snmp": {
"authentication": [ null ],
"enable": [ null ],
"warm-start": [ null ],
"cold-start": [ null ]
},
"l2vpn": {
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
}
a3_vpls_schema:
CISCO-IETF-VPLS-GENERIC-MIB notification configuration
- status: null
-
Enable cvplsStatusChanged notification
- full-raise: null
-
Enable cvplsFwdFullAlarmRaised notification
- enable: null
-
Enable CISCO-IETF-VPLS-GENERIC-MIB notifications
- full-clear: null
-
Enable cvplsFwdFullAlarmCleared notification
Example
{
"status": [ null ],
"full-raise": [ null ],
"enable": [ null ],
"full-clear": [ null ]
}
a3_l2vpn_schema:
CISCO-IETF-PW-MIB notification configuration
- vc-up: null
-
Enable cpwVcUp notification
- vc-down: null
-
Enable cpwVcDown notification
- enable: null
-
Enable CISCO-IETF-PW-MIB notifications
- cisco: null
-
Enable Cisco format including extra varbinds
Example
{
"vc-up": [ null ],
"vc-down": [ null ],
"enable": [ null ],
"cisco": [ null ]
}
a3_oam_schema:
802.3 OAM MIB notification configuration
- enable: null
-
Enable 802.3 OAM MIB notifications
Example
{
"enable": [ null ]
}
a3_correlator_schema:
Configure properties of the trap correlator
- rules: object
-
Table of configured rules
-
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
- rule-sets: object
-
Table of configured rulesets
-
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
- buffer-size: integer
-
Configure size of the correlator buffer
range:"1024..2147483647" units:"byte"
Example
{
"rules": {
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"rule-sets": {
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
},
"buffer-size": "integer"
}
a3_rules_schema:
Table of configured rules
- rule: object[]
-
Rule name
-
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"rule": [
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a3_rule_schema:
- non-root-causes: object
-
Table of configured non-rootcause
-
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
- timeout: integer
-
Timeout (time to wait for active correlation) in milliseconds
range:"1..600000" units:"millisecond" - root-causes: object
-
Table of configured rootcause (only one entry allowed)
-
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
- name: string
-
Rule name
Example
{
"non-root-causes": {
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"timeout": "integer",
"root-causes": {
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
},
"name": "string",
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a3_root-causes_schema:
Table of configured rootcause (only one entry allowed)
- root-cause: object[]
-
The rootcause - maximum of one can be configured per rule
-
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a3_root-cause_schema:
- oid: string
-
OID of rootcause trap (dotted decimal)
- created: null
-
Create rootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a3_var-binds_schema:
Varbinds to match
- var-bind: object[]
-
Varbind match conditions
-
object - oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
a3_var-bind_schema:
- oid: string
-
OID of varbind (dotted decimal)
- match: object
-
VarBind match conditions
-
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
a3_match_schema:
VarBind match conditions
- index: string
-
Regular Expression to match index
- value: string
-
Regular Expression to match value
Example
{
"index": "string",
"value": "string"
}
a3_non-root-causes_schema:
Table of configured non-rootcause
- non-root-cause: object[]
-
A non-rootcause
-
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"non-root-cause": [
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
]
}
a3_non-root-cause_schema:
- oid: string
-
OID of nonrootcause trap (dotted decimal)
- created: null
-
Create nonrootcause
Example
{
"oid": "string",
"created": [ null ],
"var-binds": {
"var-bind": [
{
"oid": "string",
"match": {
"index": "string",
"value": "string"
}
}
]
}
}
a3_applied-to_schema:
Applied to the Rule or Ruleset
- all: null
-
Apply to all of the device
- hosts: object
-
Table of configured hosts to apply rules to
-
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
a3_hosts_schema:
Table of configured hosts to apply rules to
- host: object[]
-
A destination host
-
object - port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
a3_host_schema:
- port: string
-
Port (specify 162 for default)
- ip-address: string
-
IP address
Example
{
"port": "string",
"ip-address": "string"
}
a3_rule-sets_schema:
Table of configured rulesets
- rule-set: object[]
-
Ruleset name
-
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rule-set": [
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
]
}
a3_rule-set_schema:
- name: string
-
Ruleset name
- rulenames: object
-
Table of configured rulenames
-
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"name": "string",
"rulenames": {
"rulename": [
{
"rulename": "string"
}
]
},
"applied-to": {
"all": [ null ],
"hosts": {
"host": [
{
"port": "string",
"ip-address": "string"
}
]
}
}
}
a3_rulenames_schema:
Table of configured rulenames
- rulename: object[]
-
A rulename
-
object - rulename: string
-
Rule name
Example
{
"rulename": [
{
"rulename": "string"
}
]
}
a3_bulk-stats_schema:
SNMP bulk stats configuration commands
- memory: integer
-
per process memory limit in kilo bytes
range:"100..200000" units:"kilobyte" - transfers: object
-
Periodicity for the transfer of bulk data in minutes
-
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
- objects: object
-
Configure an Object List
-
- object: object[]
-
Name of the object List
-
object - object-list-name: string
-
Name of the object List
- objects: object
-
Configure an object List
-
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
- type: null
-
Configure object list name
- schemas: object
-
Configure schema definition
-
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"memory": "integer",
"transfers": {
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
},
"objects": {
"object": [
{
"object-list-name": "string",
"objects": {
"object": [
{
"oid": "string"
}
]
},
"type": [ null ]
}
]
},
"schemas": {
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
}
a3_schemas_schema:
Configure schema definition
- schema: object[]
-
The name of the Schema
-
object - schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema": [
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
]
}
a3_schema_schema:
- schema-name: string
-
The name of the schema
- instance: object
-
Object instance information
-
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
- type: null
-
Configure schema name
- schema-object-list: string
-
Name of an object List
- poll-interval: integer
-
Periodicity for polling of objects in this schema in minutes
range:"1..20000" units:"minute"
Example
{
"schema-name": "string",
"instance": {
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
},
"type": [ null ],
"schema-object-list": "string",
"poll-interval": "integer"
}
a3_instance_schema:
Object instance information
- end: string
-
End Instance OID for repetition
- sub-interface: boolean
-
Include all the subinterface
- start: string
-
Start Instance OID for repetition
- max: integer
-
Max value of Instance repetition
- instance: string
-
Instance of the schema
- type: string exact-interface, exact-oid, wild-interface, wild-oid, range-oid, repeat-oid
-
Type of the instance
Example
{
"end": "string",
"sub-interface": "boolean",
"start": "string",
"max": "integer",
"instance": "string",
"type": "string"
}
a3_objects_schema:
Configure an object List
- object: object[]
-
Object name or OID
-
object - oid: string
-
Object name or OID
Example
{
"object": [
{
"oid": "string"
}
]
}
a3_transfers_schema:
Periodicity for the transfer of bulk data in minutes
- transfer: object[]
-
Name of bulk transfer
-
object - retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"transfer": [
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
]
}
a3_transfer_schema:
- retry: integer
-
Number of transmission retries
range:"0..100" - transfer-schemas: object
-
Schema that contains objects to be collected
-
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
- format: string schema-ascii, bulk-ascii, bulk-binary
-
Format of the bulk data file
- interval: integer
-
Periodicity for the transfer of bulk data in minutes
units:"minute" - primary: string
-
FTP or rcp or TFTP can be used for file transfer
- buffer-size: integer
-
Bulkstat data file maximum size in bytes
range:"1024..2147483647" units:"byte" - enable: null
-
Start Data Collection for this Configuration
- transfer-name: string
-
Name of bulk transfer
- retain: integer
-
Retention period in minutes
range:"0..20000" units:"minute" - type: null
-
Configure transfer list name
- secondary: string
-
FTP or rcp or TFTP can be used for file transfer
Example
{
"retry": "integer",
"transfer-schemas": {
"transfer-schema": [
{
"schema-name": "string"
}
]
},
"format": "string",
"interval": "integer",
"primary": "string",
"buffer-size": "integer",
"enable": [ null ],
"transfer-name": "string",
"retain": "integer",
"type": [ null ],
"secondary": "string"
}
a3_transfer-schemas_schema:
Schema that contains objects to be collected
- transfer-schema: object[]
-
Schema that contains objects to be collected
-
object - schema-name: string
-
Schema that contains objects to be collected
Example
{
"transfer-schema": [
{
"schema-name": "string"
}
]
}
a3_transfer-schema_schema:
- schema-name: string
-
Schema that contains objects to be collected
Example
{
"schema-name": "string"
}
a3_default-community-maps_schema:
Container class to hold unencrpted community map
- default-community-map: object[]
-
Unencrpted SNMP community map name
-
object - security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"default-community-map": [
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
]
}
a3_default-community-map_schema:
- security: string
-
SNMP Security Name
- community-name: string
-
SNMP community map
- context: string
-
SNMP Context Name
- target-list: string
-
target list name
Example
{
"security": "string",
"community-name": "string",
"context": "string",
"target-list": "string"
}
a3_overload-control_schema:
Set overload control params for handling incoming messages
- drop-time: integer
-
Drop time in seconds for incoming queue (default 1 sec)
range:"0..300" units:"second" - throttle-rate: integer
-
Throttle time in milliseconds for incoming queue (default 500 msec)
range:"0..1000" units:"millisecond"
Example
{
"drop-time": "integer",
"throttle-rate": "integer"
}
a3_timeouts_schema:
SNMP timeouts
- duplicates: integer
-
Duplicate request feature timeout
range:"0..20" units:"second" default:"1" - pdu-stats: integer
-
SNMP pdu statistics timeout
range:"1..10" units:"second" default:"2" - in-qdrop: integer
-
incoming queue drop feature timeout
range:"0..20" units:"second" default:"10" - subagent: integer
-
Sub-Agent Request timeout
range:"1..20" units:"second" default:"10"
Example
{
"duplicates": "integer",
"pdu-stats": "integer",
"in-qdrop": "integer",
"subagent": "integer"
}
a3_users_schema:
Define a user who can access the SNMP engine
- user: object[]
-
Name of the user
-
object - v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"user": [
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
]
}
a3_user_schema:
- v6acl-type: string ipv4, ipv6
-
Access-list type
- group-name: string
-
Group to which the user belongs
- v6-access-list: string
-
Ipv6 Access-list name
- priv-algorithm: string none, des, 3des, aes128, aes192, aes256
-
The algorithm used des56 or aes128 or aes192or aes256 or 3des
- owner: string sdr-owner, system-owner
-
The system access either SDROwner or SystemOwner
- v4acl-type: string ipv4, ipv6
-
Access-list type
- privacy-password: string
-
The privacy password
- remote-address: string
-
IP address of remote SNMP entity
- port: string
-
UDP port number
- user-name: string
-
Name of the user
- algorithm: string none, md5, sha
-
The algorithm used md5 or sha
- privacy-password-configured: null
-
Flag to indicate that the privacy password is configured for version 3
- authentication-password: string
-
The authentication password
- version: string v1, v2c, v3
-
SNMP version to be used. v1,v2c or v3
- v4-access-list: string
-
Ipv4 Access-list name
- authentication-password-configured: null
-
Flag to indicate that authentication password is configred for version 3
Example
{
"v6acl-type": "string",
"group-name": "string",
"v6-access-list": "string",
"priv-algorithm": "string",
"owner": "string",
"v4acl-type": "string",
"privacy-password": "string",
"remote-address": "string",
"port": "string",
"user-name": "string",
"algorithm": "string",
"privacy-password-configured": [ null ],
"authentication-password": "string",
"version": "string",
"v4-access-list": "string",
"authentication-password-configured": [ null ]
}
a3_vrfs_schema:
SNMP VRF configuration commands
- vrf: object[]
-
VRF name
-
- name: string
-
VRF name
Example
{
"vrf": [
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
]
}
a3_vrf_schema:
- name: string
-
VRF name
Example
{
"name": "string",
"context-mappings": {
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
}
a3_trap-hosts_schema:
Specify hosts to receive SNMP notifications
- trap-host: object[]
-
Specify hosts to receive SNMP notifications
-
object - encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"trap-host": [
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
]
}
a3_trap-host_schema:
- encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a trap host
-
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-host: object
-
Container class for defining notification type for a Inform host
-
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- ip-address: string
-
IP address of SNMP notification host
- default-user-communities: object
-
Container class for defining communities for a trap host
-
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-communities": {
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-host": {
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
},
"ip-address": "string",
"default-user-communities": {
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a3_encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a trap host
- encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a3_encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a3_inform-host_schema:
Container class for defining notification type for a Inform host
- inform-encrypted-user-communities: object
-
Container class for defining Clear/encrypt communities for a inform host
-
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
- inform-user-communities: object
-
Container class for defining communities for a inform host
-
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-communities": {
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
},
"inform-user-communities": {
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
}
a3_inform-user-communities_schema:
Container class for defining communities for a inform host
- inform-user-community: object[]
-
Unencrpted Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a3_inform-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a3_inform-encrypted-user-communities_schema:
Container class for defining Clear/encrypt communities for a inform host
- inform-encrypted-user-community: object[]
-
Clear/Encrypt Community name associated with a inform host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"inform-encrypted-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a3_inform-encrypted-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v2c/v3
- community-name: string
-
SNMPv2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072 ,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a3_default-user-communities_schema:
Container class for defining communities for a trap host
- default-user-community: object[]
-
Unencrpted Community name associated with a trap host
-
object - port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"default-user-community": [
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
]
}
a3_default-user-community_schema:
- port: string
-
UDP port number
- version: string
-
SNMP Version to be used v1/v2c/v3
- community-name: string
-
SNMPv1/v2c community string or SNMPv3 user
- basic-trap-types: integer
-
Number to signify the feature traps that needs to be setBasicTrapTypes is used for all traps except copy-completeSet this value to an integer corresponding to the trapBGP 8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide a combination of trap Add the respective numbersValue must be set to 0 for all traps
- advanced-trap-types2: integer
-
Number to signify the feature traps that needs to be setvalue should always to set as 0
- security-level: string no-authentication, authentication, privacy
-
Security level to be used noauth/auth/priv
- advanced-trap-types1: integer
-
Number to signify the feature traps that needs to be setUse this for providing copy-complete trapValue must be set to 0 if not used
Example
{
"port": "string",
"version": "string",
"community-name": "string",
"basic-trap-types": "integer",
"advanced-trap-types2": "integer",
"security-level": "string",
"advanced-trap-types1": "integer"
}
a3_contexts_schema:
List of Context Names
- context: object[]
-
Context Name
-
object - context-name: string
-
Context Name
Example
{
"context": [
{
"context-name": "string"
}
]
}
a3_context-mappings_schema:
List of context names
- context-mapping: object[]
-
Context mapping name
-
object - context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping": [
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
]
}
a3_context-mapping_schema:
- context-mapping-name: string
-
Context mapping name
- vrf-name: string
-
VRF name associated with the context
- topology-name: string
-
Topology name associated with the context
- context: string vrf, bridge, ospf, ospfv3
-
SNMP context feature type
- instance-name: string
-
OSPF protocol instance
Example
{
"context-mapping-name": "string",
"vrf-name": "string",
"topology-name": "string",
"context": "string",
"instance-name": "string"
}
a3_groups_schema:
Define a User Security Model group
- group: object[]
-
Name of the group
-
object - name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"group": [
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
]
}
a3_group_schema:
- name: string
-
Name of the group
- write-view: string
-
write view name
- snmp-version: string v1, v2c, v3
-
snmp version
- context-name: string
-
Context name
- security-model: string no-authentication, authentication, privacy
-
security model like auth/noAuth/Priv applicable for v3
- v6acl-type: string ipv4, ipv6
-
Access-list type
- v6-access-list: string
-
Ipv6 Access-list name
- read-view: string
-
read view name
- v4acl-type: string ipv4, ipv6
-
Access-list type
- v4-access-list: string
-
Ipv4 Access-list name
- notify-view: string
-
notify view name
Example
{
"name": "string",
"write-view": "string",
"snmp-version": "string",
"context-name": "string",
"security-model": "string",
"v6acl-type": "string",
"v6-access-list": "string",
"read-view": "string",
"v4acl-type": "string",
"v4-access-list": "string",
"notify-view": "string"
}
a3_ethernet-features_schema:
Ethernet Features Configuration
- ether-link-oam-enable: null
-
Enable Ethernet Link OAM on the interface
- ether-link-oam:
-
Ethernet Link OAM Interface Configuration
- filtering: string filtering-type-dot1q, filtering-type-dot1ad
-
Ingress Ethernet frame filtering
Example
{
"ether-link-oam-enable": [ null ],
"ether-link-oam": {
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
}
a3_egress-filtering_schema:
Egress Filtering Configuration
- egress-filtering-default-on: null
-
Whether Egress Filtering is on by default
Example
{
"egress-filtering-default-on": [ null ]
}
a3_ether-link-oam_schema:
Ethernet Link OAM Interface Configuration
- udlf: boolean
-
Enable or disable uni-directional link-fault detection
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback
- mib-retrieval: boolean
-
Enable or disable MIB retrieval
- mode: string passive, active
-
Possible Ethernet Link OAM modes
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session comes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval peer requirement
- link-monitoring: boolean
-
Enable or disable link monitoring peer requirement
- mode: string passive, active, dont-care
-
Possible required peer modes
- remote-loopback: boolean
-
Enable or disable remote loopback peer requirement
- profile-name: string
-
Set the profile to use on the interface
Example
{
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
a3_profiles_schema:
Table of Ethernet Link OAM profiles
- profile: object[]
-
Name of the profile
-
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"profile": [
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
]
}
a3_profile_schema:
- profile: string
-
none
- hello-interval: string 1s, 100ms
-
Possible Ethernet Link OAM hello intervals
- remote-loopback: boolean
-
Enable or disable remote loopback support
- mib-retrieval: boolean
-
Enable or disable MIB retrieval support
- mode: string passive, active
-
Set the OAM mode to passive
- timeout: integer
-
Connection timeout period in number of lost heartbeats
range:"1..600000" units:"millisecond" - action: object
-
Configure action parameters
-
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault message is received
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session goes down
- require-remote: object
-
Configure remote requirement parameters
-
- mib-retrieval: boolean
-
Enable or disable MIB retrieval requirement
- link-monitoring: boolean
-
Enable or disable link monitoring requirement
- mode: string passive, active, dont-care
-
Possible required OAM modes
- remote-loopback: boolean
-
Enable or disable remote loopback requirement
- udlf: boolean
-
Enable or disable uni-directional link-fault detection support
Example
{
"profile": "string",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"link-fault": "string",
"critical-event": "string",
"discovery-timeout": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"udlf": "boolean",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
}
a3_action_schema:
Configure action parameters
- dying-gasp: string disable, error-disable, log
-
Action to perform when a dying gasp occurs
- capabilities-conflict: string disable, error-disable, log, efd
-
Action to perform when a capabilities conflict occurs
- remote-loopback: string disable, log
-
Action to perform when remote loopback is entered or exited
- session-up: string disable, log
-
Action to perform when a session comes up
- critical-event: string disable, error-disable, log
-
Action to perform when a critical event occurs
- link-fault: string disable, error-disable, log, efd
-
Action to perform when a link fault occurs
- high-threshold: string disable, error-disable, log
-
Action to perform when a high-threshold event occurs
- wiring-conflict: string disable, error-disable, log, efd
-
Action to perform when a wiring conflict occurs
- discovery-timeout: string disable, error-disable, log, efd
-
Action to perform when discovery timeout occurs
- session-down: string disable, error-disable, log, efd
-
Action to perform when a session comes down
Example
{
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
}
a3_require-remote_schema:
Configure remote requirement parameters
- mib-retrieval: boolean
-
Enable or disable MIB retrieval peer requirement
- link-monitoring: boolean
-
Enable or disable link monitoring peer requirement
- mode: string passive, active, dont-care
-
Possible required peer modes
- remote-loopback: boolean
-
Enable or disable remote loopback peer requirement
Example
{
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
}
a3_link-monitoring_schema:
Configure link monitor parameters
- frame-seconds: object
-
Frame-seconds event configuration
-
- threshold: object
-
Threshold configuration for frame-seconds events
-
- threshold-high: integer
-
The high threshold for frame-seconds events
range:"1..4294967295" units:"second" - threshold-low: integer
-
The low threshold for frame-seconds events
range:"1..4294967295" units:"second" default:"1"
- window: integer
-
Window size configuration for frame-seconds events
range:"1000..60000" units:"millisecond" default:"60000"
- symbol-period: object
-
Symbol-period event configuration
-
- threshold: object
-
Threshold configuration for symbol-period events
-
- threshold-high: integer
-
The high threshold for symbol-period
range:"1..4294967295" units:"second" - units: string symbols, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for symbol-period
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- window: object
-
Window size configuration for symbol-period events
-
- units: string milliseconds, symbols
-
Units to use for this window
- window: integer
-
Size of the symbol-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- monitoring: boolean
-
Enable or disable monitoring
- frame: object
-
Frame event configuration
-
- threshold: object
-
Threshold configuration for frame events
-
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
- window: integer
-
Window size configuration for frame events
range:"1000..60000" units:"millisecond" default:"60000"
- frame-period: object
-
Frame-period event configuration
-
- threshold: object
-
Threshold configuration for frame-period events
-
- threshold-high: integer
-
The high threshold for frame-period events
range:"1..4294967295" units:"second" - units: string frames, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame-period events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- window: object
-
Window size configuration for frame-period events
-
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
a3_symbol-period_schema:
Symbol-period event configuration
- threshold: object
-
Threshold configuration for symbol-period events
-
- threshold-high: integer
-
The high threshold for symbol-period
range:"1..4294967295" units:"second" - units: string symbols, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for symbol-period
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Symbols and treated as 1 if unspecified)
- window: object
-
Window size configuration for symbol-period events
-
- units: string milliseconds, symbols
-
Units to use for this window
- window: integer
-
Size of the symbol-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Symbols and treated as 1 if unspecified)
Example
{
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
a3_window_schema:
Window size configuration for frame-period events
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"units": "string",
"window": "integer",
"multiplier": "string"
}
a3_frame-period_schema:
Frame-period event configuration
- threshold: object
-
Threshold configuration for frame-period events
-
- threshold-high: integer
-
The high threshold for frame-period events
range:"1..4294967295" units:"second" - units: string frames, ppm
-
The units to use for these thresholds
- multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame-period events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (only valid if 'Units' is Frames and treated as 1 if unspecified)
- window: object
-
Window size configuration for frame-period events
-
- units: string milliseconds, frames
-
The units to use for this window
- window: integer
-
Size of the frame-period window
range:"1000..60000" units:"millisecond" default:"60000" - multiplier: string none, thousand, million, billion
-
The multiplier to use for this window (only valid if 'Units' is Frames and treated as 1 if unspecified)
Example
{
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
a3_frame-seconds_schema:
Frame-seconds event configuration
- threshold: object
-
Threshold configuration for frame-seconds events
-
- threshold-high: integer
-
The high threshold for frame-seconds events
range:"1..4294967295" units:"second" - threshold-low: integer
-
The low threshold for frame-seconds events
range:"1..4294967295" units:"second" default:"1"
- window: integer
-
Window size configuration for frame-seconds events
range:"1000..60000" units:"millisecond" default:"60000"
Example
{
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
}
a3_frame_schema:
Frame event configuration
- threshold: object
-
Threshold configuration for frame events
-
- threshold-high: integer
-
The high threshold for frame events
range:"1..4294967295" units:"second" - multiplier-low: string none, thousand, million, billion
-
The multiplier to use for the low threshold (treated as 1 if unspecified)
- threshold-low: integer
-
The low threshold for frame events
range:"1..4294967295" units:"second" default:"1" - multiplier-high: string none, thousand, million, billion
-
The multiplier to use for the high threshold (treated as 1 if unspecified)
- window: integer
-
Window size configuration for frame events
range:"1000..60000" units:"millisecond" default:"60000"
Example
{
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
}
a3_global-interface-configuration_schema:
Global scoped configuration for interfaces
- link-status: string default, disable, software-interfaces
-
Enable or disable link-status messages
Example
{
"link-status": "string"
}
a3_interface-configurations_schema:
interface configurations
- interface-configuration: object[]
-
The configuration for an interface
-
object - interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- description: string
-
The description of this interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- mac-accounting: object
-
MAC Accounting Configuration
-
- ingress: null
-
Per MAC address accounting statistics
- egress: null
-
Per MAC address accounting statistics
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - ethernet-features: object
-
Ethernet Features Configuration
-
- ether-link-oam-enable: null
-
Enable Ethernet Link OAM on the interface
- ether-link-oam:
-
Ethernet Link OAM Interface Configuration
- filtering: string filtering-type-dot1q, filtering-type-dot1ad
-
Ingress Ethernet frame filtering
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- vlan-trunk-configuration: object
-
IEEE 802.1Q VLAN trunk interface configuration
-
- native-vlan-identifier: object
-
The Native VLAN identifier associated with this trunk interface
-
- vlan-type: string
-
Whether this interface is dot1ad or dot1Q
- vlan-identifier: string
-
VLAN identifier
- tunneling-ethertype: string 0x9100, 0x9200
-
The outer ethertype used in Q-in-Q frames. The default value is 0x8100
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- bvi: object
-
BVI attributes
-
- host-routing: null
-
Enable host-routing on this BVI
- carrier-delay: object
-
Set the carrier transition delay on an interface in msecs
-
- carrier-delay-up: integer
-
Carrier Delay (up) in msecs
range:"1..65535" - carrier-delay-down: integer
-
Carrier Delay down in msecs, must be set to 0
- vlan-sub-configuration: object
-
IEEE 802.1Q VLAN subinterface configuration
-
- vlan-identifier: object
-
The VLAN tag stack associated with this sub-interface.
-
- vlan-type: string
-
Whether this sub-interface is dot1ad or dot1Q
- first-tag: string
-
First (outermost) VLAN tag value
- second-tag: string
-
Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces
- l2-transport: object
-
Interface Layer 2 Transport service configuration data
-
- propagate-remote-status: null
-
Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state
- l2-protocols: object
-
Interface specific Layer 2 protocol handling
-
- l2-protocol: object[]
-
Handling of a specific Layer 2 protocol
-
object - mpls-exp-bits-value: string
-
The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop
- l2-protocol-name: string cdp, stp, vtp, pvst, cpsv
-
Protocol name
- mode: string forward, drop, tunnel, reverse-tunnel
-
How to handle the protocol's packets
- enabled: null
-
This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.
- l2-ethernet-features: object
-
L2 Ethernet Features Configuration
-
- egress-filtering: string egress-filtering-type-strict, egress-filtering-type-disable, egress-filtering-type-default
-
Egress Ethernet filtering
- source-bypass-egress-filtering: null
-
Mark all ingress packets to bypass any egress VLAN filter
- pseudowire-iw: object
-
PW-IW attributes
-
- generic-interface-list: string
-
Name of the interface list
- l2-overhead: integer
-
L2 overhead size in bytes
- dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- interface-name: string
-
The name of the interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- ethernet-service: object
-
Ethernet service configuration
-
- local-traffic-default-encapsulation: object
-
The default encapsulation to be used for locally-sourced packets
-
- outer-tag-type: string
-
Type of outer tag
- outer-vlan-id: string
-
VLAN id for outer tag
- inner-vlan-id: string
-
Optional VLAN Id for inner Dot1Q tag
- rewrite: object
-
The rewrite operation for the Ethernet service
-
- inner-tag-value: string
-
VLAN Id of innermost tag to be pushed
- rewrite-type: string
-
The type of rewrite to perform
- outer-tag-value: string
-
VLAN Id of outermost tag to be pushed
- inner-tag-type: string
-
Type of innermost tag to be pushed
- outer-tag-type: string
-
Type of outermost tag to be pushed
- encapsulation: object
-
The encapsulation of this Ethernet service
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
- pseudowire-ether: object
-
PW-Ether attributes
-
- l2-overhead: integer
-
PW Ether L2 overhead requirement
- generic-interface-list: string
-
Name of the interface list
- link-status: null
-
Enable interface and line-protocol state change alarms
- mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
range:"64..65535" -
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- ethernet-bng: object
-
Ethernet Infra BNG specific configuration
-
- ambiguous-encapsulation: object
-
L3 Ambiguous encapsulation
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"interface-configuration": [
{
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ],
"mac-accounting": {
"ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer",
"ethernet-features": {
"ether-link-oam-enable": [ null ],
"ether-link-oam": {
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ],
"vlan-trunk-configuration": {
"native-vlan-identifier": {
"vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"bvi": {
"host-routing": [ null ]
},
"carrier-delay": {
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
},
"vlan-sub-configuration": {
"vlan-identifier": {
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
},
"l2-transport": {
"propagate-remote-status": [ null ],
"l2-protocols": {
"l2-protocol": [ null ]
}
}
}
]
}
a3_interface-configuration_schema:
- interface-mode-non-physical: string default, point-to-point, multipoint, l2-transport
-
The mode in which an interface is running. The existence of this object causes the creation of the software subinterface.
- description: string
-
The description of this interface
- interface-virtual: null
-
The mode in which an interface is running. The existence of this object causes the creation of the software virtual/subinterface.
- mac-accounting: object
-
MAC Accounting Configuration
-
- ingress: null
-
Per MAC address accounting statistics
- egress: null
-
Per MAC address accounting statistics
- bandwidth: integer
-
The bandwidth of the interface in kbps
range:"0..4294967295" units:"kbit/s" - ethernet-features: object
-
Ethernet Features Configuration
-
- ether-link-oam-enable: null
-
Enable Ethernet Link OAM on the interface
- ether-link-oam:
-
Ethernet Link OAM Interface Configuration
- filtering: string filtering-type-dot1q, filtering-type-dot1ad
-
Ingress Ethernet frame filtering
- shutdown: null
-
The existence of this configuration indicates the interface is shut down
- vlan-trunk-configuration: object
-
IEEE 802.1Q VLAN trunk interface configuration
-
- native-vlan-identifier: object
-
The Native VLAN identifier associated with this trunk interface
-
- vlan-type: string
-
Whether this interface is dot1ad or dot1Q
- vlan-identifier: string
-
VLAN identifier
- tunneling-ethertype: string 0x9100, 0x9200
-
The outer ethertype used in Q-in-Q frames. The default value is 0x8100
- active: string
-
Whether the interface is active or preconfigured
- encapsulation: object
-
The encapsulation on the interface
-
- encapsulation: string
-
The encapsulation - e.g. hdlc, ppp
- capsulation-options: integer
-
The options for this capsulation, usually '0'
- bvi: object
-
BVI attributes
-
- host-routing: null
-
Enable host-routing on this BVI
- carrier-delay: object
-
Set the carrier transition delay on an interface in msecs
-
- carrier-delay-up: integer
-
Carrier Delay (up) in msecs
range:"1..65535" - carrier-delay-down: integer
-
Carrier Delay down in msecs, must be set to 0
- vlan-sub-configuration: object
-
IEEE 802.1Q VLAN subinterface configuration
-
- vlan-identifier: object
-
The VLAN tag stack associated with this sub-interface.
-
- vlan-type: string
-
Whether this sub-interface is dot1ad or dot1Q
- first-tag: string
-
First (outermost) VLAN tag value
- second-tag: string
-
Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces
- l2-transport: object
-
Interface Layer 2 Transport service configuration data
-
- propagate-remote-status: null
-
Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state
- l2-protocols: object
-
Interface specific Layer 2 protocol handling
-
- l2-protocol: object[]
-
Handling of a specific Layer 2 protocol
-
object - mpls-exp-bits-value: string
-
The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop
- l2-protocol-name: string cdp, stp, vtp, pvst, cpsv
-
Protocol name
- mode: string forward, drop, tunnel, reverse-tunnel
-
How to handle the protocol's packets
- enabled: null
-
This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.
- l2-ethernet-features: object
-
L2 Ethernet Features Configuration
-
- egress-filtering: string egress-filtering-type-strict, egress-filtering-type-disable, egress-filtering-type-default
-
Egress Ethernet filtering
- source-bypass-egress-filtering: null
-
Mark all ingress packets to bypass any egress VLAN filter
- pseudowire-iw: object
-
PW-IW attributes
-
- generic-interface-list: string
-
Name of the interface list
- l2-overhead: integer
-
L2 overhead size in bytes
- dampening: object
-
Whether this interface's state changes are dampened or not
-
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
- interface-name: string
-
The name of the interface
- secondary-admin-state: string normal, maintenance
-
The secondary admin state of the interface
- ethernet-service: object
-
Ethernet service configuration
-
- local-traffic-default-encapsulation: object
-
The default encapsulation to be used for locally-sourced packets
-
- outer-tag-type: string
-
Type of outer tag
- outer-vlan-id: string
-
VLAN id for outer tag
- inner-vlan-id: string
-
Optional VLAN Id for inner Dot1Q tag
- rewrite: object
-
The rewrite operation for the Ethernet service
-
- inner-tag-value: string
-
VLAN Id of innermost tag to be pushed
- rewrite-type: string
-
The type of rewrite to perform
- outer-tag-value: string
-
VLAN Id of outermost tag to be pushed
- inner-tag-type: string
-
Type of innermost tag to be pushed
- outer-tag-type: string
-
Type of outermost tag to be pushed
- encapsulation: object
-
The encapsulation of this Ethernet service
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
- pseudowire-ether: object
-
PW-Ether attributes
-
- l2-overhead: integer
-
PW Ether L2 overhead requirement
- generic-interface-list: string
-
Name of the interface list
- link-status: null
-
Enable interface and line-protocol state change alarms
- mtus: object
-
The MTU configuration for the interface
-
- mtu: object[]
-
The MTU for the interface
range:"64..65535" -
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
- ethernet-bng: object
-
Ethernet Infra BNG specific configuration
-
- ambiguous-encapsulation: object
-
L3 Ambiguous encapsulation
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"interface-mode-non-physical": "string",
"description": "string",
"interface-virtual": [ null ],
"mac-accounting": {
"ingress": [ null ],
"egress": [ null ]
},
"bandwidth": "integer",
"ethernet-features": {
"ether-link-oam-enable": [ null ],
"ether-link-oam": {
"udlf": "boolean",
"hello-interval": "string",
"remote-loopback": "boolean",
"mib-retrieval": "boolean",
"mode": "string",
"timeout": "integer",
"action": {
"dying-gasp": "string",
"capabilities-conflict": "string",
"remote-loopback": "string",
"session-up": "string",
"critical-event": "string",
"link-fault": "string",
"high-threshold": "string",
"wiring-conflict": "string",
"discovery-timeout": "string",
"session-down": "string"
},
"require-remote": {
"mib-retrieval": "boolean",
"link-monitoring": "boolean",
"mode": "string",
"remote-loopback": "boolean"
},
"profile-name": "string",
"link-monitoring": {
"frame-seconds": {
"threshold": {
"threshold-high": "integer",
"threshold-low": "integer"
},
"window": "integer"
},
"symbol-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
},
"monitoring": "boolean",
"frame": {
"threshold": {
"threshold-high": "integer",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": "integer"
},
"frame-period": {
"threshold": {
"threshold-high": "integer",
"units": "string",
"multiplier-low": "string",
"threshold-low": "integer",
"multiplier-high": "string"
},
"window": {
"units": "string",
"window": "integer",
"multiplier": "string"
}
}
}
},
"filtering": "string"
},
"shutdown": [ null ],
"vlan-trunk-configuration": {
"native-vlan-identifier": {
"vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
},
"active": "string",
"encapsulation": {
"encapsulation": "string",
"capsulation-options": "integer"
},
"bvi": {
"host-routing": [ null ]
},
"carrier-delay": {
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
},
"vlan-sub-configuration": {
"vlan-identifier": {
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
},
"l2-transport": {
"propagate-remote-status": [ null ],
"l2-protocols": {
"l2-protocol": [
{
"mpls-exp-bits-value": "string"
}
]
}
}
}
a3_dampening_schema:
Whether this interface's state changes are dampened or not
- args: string default-values, specify-half-life, specify-all, specify-rp
-
Dampening Arguments
- suppress-threshold: integer
-
Suppress threshold
range:"1..20000" - half-life: integer
-
Decay half life (in minutes)
range:"1..45" units:"minute" - suppress-time: integer
-
Max suppress time (in minutes)
range:"1..255" units:"minute" - reuse-threshold: integer
-
Reuse threshold
range:"1..20000" - restart-penalty: integer
-
Restart penalty
range:"0..20000"
Example
{
"args": "string",
"suppress-threshold": "integer",
"half-life": "integer",
"suppress-time": "integer",
"reuse-threshold": "integer",
"restart-penalty": "integer"
}
a3_mtus_schema:
The MTU configuration for the interface
- mtu: object[]
-
The MTU for the interface
-
object - owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"mtu": [
{
"owner": "string",
"mtu": "integer"
}
]
}
a3_mtu_schema:
- owner: string
-
The Owner of the interface - eg. for 'LoopbackX' main interface this is 'loopback'
- mtu: integer
-
The MTU value
range:"64..65535"
Example
{
"owner": "string",
"mtu": "integer"
}
a3_encapsulation_schema:
The encapsulation of this Ethernet service
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
a3_pseudowire-ether_schema:
PW-Ether attributes
- l2-overhead: integer
-
PW Ether L2 overhead requirement
- generic-interface-list: string
-
Name of the interface list
Example
{
"l2-overhead": "integer",
"generic-interface-list": "string"
}
a3_pseudowire-iw_schema:
PW-IW attributes
- generic-interface-list: string
-
Name of the interface list
- l2-overhead: integer
-
L2 overhead size in bytes
Example
{
"generic-interface-list": "string",
"l2-overhead": "integer"
}
a3_bvi_schema:
BVI attributes
- host-routing: null
-
Enable host-routing on this BVI
Example
{
"host-routing": [ null ]
}
a3_l2-transport_schema:
Interface Layer 2 Transport service configuration data
- propagate-remote-status: null
-
Enable propagation of the remote attachment-circuit link state to the localattachment-circuit link state
- l2-protocols: object
-
Interface specific Layer 2 protocol handling
-
- l2-protocol: object[]
-
Handling of a specific Layer 2 protocol
-
object - mpls-exp-bits-value: string
-
The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop
- l2-protocol-name: string cdp, stp, vtp, pvst, cpsv
-
Protocol name
- mode: string forward, drop, tunnel, reverse-tunnel
-
How to handle the protocol's packets
- enabled: null
-
This object is only valid on physical interfaces and it controls whether that interface is a port mode Layer 2 attachment circuit (note that for subinterfaces, the Layer 2 property is specified when the subinterface is created).The object must be set before any other L2Transport configuration is supplied for the interface, and must be the last per-interface configuration object to be removed.
- l2-ethernet-features: object
-
L2 Ethernet Features Configuration
-
- egress-filtering: string egress-filtering-type-strict, egress-filtering-type-disable, egress-filtering-type-default
-
Egress Ethernet filtering
- source-bypass-egress-filtering: null
-
Mark all ingress packets to bypass any egress VLAN filter
Example
{
"propagate-remote-status": [ null ],
"l2-protocols": {
"l2-protocol": [
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
]
},
"enabled": [ null ],
"l2-ethernet-features": {
"egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
}
a3_l2-protocols_schema:
Interface specific Layer 2 protocol handling
- l2-protocol: object[]
-
Handling of a specific Layer 2 protocol
-
object - mpls-exp-bits-value: string
-
The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop
- l2-protocol-name: string cdp, stp, vtp, pvst, cpsv
-
Protocol name
- mode: string forward, drop, tunnel, reverse-tunnel
-
How to handle the protocol's packets
Example
{
"l2-protocol": [
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
]
}
a3_l2-protocol_schema:
- mpls-exp-bits-value: string
-
The value to set the MPLS Exp bits to within the PW.This value may be specified if the mode is forward or tunnel and must not be specified if the mode is drop
- l2-protocol-name: string cdp, stp, vtp, pvst, cpsv
-
Protocol name
- mode: string forward, drop, tunnel, reverse-tunnel
-
How to handle the protocol's packets
Example
{
"mpls-exp-bits-value": "string",
"l2-protocol-name": "string",
"mode": "string"
}
a3_l2-ethernet-features_schema:
L2 Ethernet Features Configuration
- egress-filtering: string egress-filtering-type-strict, egress-filtering-type-disable, egress-filtering-type-default
-
Egress Ethernet filtering
- source-bypass-egress-filtering: null
-
Mark all ingress packets to bypass any egress VLAN filter
Example
{
"egress-filtering": "string",
"source-bypass-egress-filtering": [ null ]
}
a3_vlan-sub-configuration_schema:
IEEE 802.1Q VLAN subinterface configuration
- vlan-identifier: object
-
The VLAN tag stack associated with this sub-interface.
-
- vlan-type: string
-
Whether this sub-interface is dot1ad or dot1Q
- first-tag: string
-
First (outermost) VLAN tag value
- second-tag: string
-
Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces
Example
{
"vlan-identifier": {
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
}
a3_vlan-identifier_schema:
The VLAN tag stack associated with this sub-interface.
- vlan-type: string
-
Whether this sub-interface is dot1ad or dot1Q
- first-tag: string
-
First (outermost) VLAN tag value
- second-tag: string
-
Second VLAN tag value. The any value may only be used for Layer 2 subinterfaces
Example
{
"vlan-type": "string",
"first-tag": "string",
"second-tag": "string"
}
a3_ethernet-service_schema:
Ethernet service configuration
- local-traffic-default-encapsulation: object
-
The default encapsulation to be used for locally-sourced packets
-
- outer-tag-type: string
-
Type of outer tag
- outer-vlan-id: string
-
VLAN id for outer tag
- inner-vlan-id: string
-
Optional VLAN Id for inner Dot1Q tag
- rewrite: object
-
The rewrite operation for the Ethernet service
-
- inner-tag-value: string
-
VLAN Id of innermost tag to be pushed
- rewrite-type: string
-
The type of rewrite to perform
- outer-tag-value: string
-
VLAN Id of outermost tag to be pushed
- inner-tag-type: string
-
Type of innermost tag to be pushed
- outer-tag-type: string
-
Type of outermost tag to be pushed
- encapsulation: object
-
The encapsulation of this Ethernet service
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"local-traffic-default-encapsulation": {
"outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
},
"rewrite": {
"inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
},
"encapsulation": {
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
a3_local-traffic-default-encapsulation_schema:
The default encapsulation to be used for locally-sourced packets
- outer-tag-type: string
-
Type of outer tag
- outer-vlan-id: string
-
VLAN id for outer tag
- inner-vlan-id: string
-
Optional VLAN Id for inner Dot1Q tag
Example
{
"outer-tag-type": "string",
"outer-vlan-id": "string",
"inner-vlan-id": "string"
}
a3_rewrite_schema:
The rewrite operation for the Ethernet service
- inner-tag-value: string
-
VLAN Id of innermost tag to be pushed
- rewrite-type: string
-
The type of rewrite to perform
- outer-tag-value: string
-
VLAN Id of outermost tag to be pushed
- inner-tag-type: string
-
Type of innermost tag to be pushed
- outer-tag-type: string
-
Type of outermost tag to be pushed
Example
{
"inner-tag-value": "string",
"rewrite-type": "string",
"outer-tag-value": "string",
"inner-tag-type": "string",
"outer-tag-type": "string"
}
a3_ethernet-bng_schema:
Ethernet Infra BNG specific configuration
- ambiguous-encapsulation: object
-
L3 Ambiguous encapsulation
-
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"ambiguous-encapsulation": {
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
}
a3_ambiguous-encapsulation_schema:
L3 Ambiguous encapsulation
- ingress-destination-mac: string
-
Destination MAC address to match on egress
- additional-range4-high: string
-
High value of forth additional range for tag match
- additional-range1-low: string
-
Low value of first additional range for tag match
- inner-range1-high: string
-
High value of first range for inner tag match
- additional-range8-high: string
-
High value of eighth additional range for tag match
- additional-range6-low: string
-
Low value of sixth additional range for tag match
- outer-range1-low: string
-
Low value of first range for outer tag match
- inner-tag-type: string
-
Type of tag for inner match (if present)
- additional-range3-low: string
-
Low value of third additional range for tag match
- inner-class-of-service: string
-
Value to match against Class Of Service bits for inner tag
- additional-range8-low: string
-
Low value of eighth additional range for tag match
- payload-ethertype-match: string
-
Which payload ethertype values to match
- additional-range2-low: string
-
Low value of second additional range for tag match
- inner-range1-low: string
-
Low value of first range for inner tag match
- additional-range7-high: string
-
High value of seventh additional range for tag match
- outer-class-of-service: string
-
Value to match against Class Of Service bits for outer tag
- additional-range3-high: string
-
High value of third additional range for tag match
- ingress-source-mac: string
-
Source MAC address to match on ingress
- outer-range1-high: string
-
High value of first range for outer tag match
- additional-range7-low: string
-
Low value of seventh additional range for tag match
- additional-range5-high: string
-
High value of fifth additional range for tag match
- additional-range6-high: string
-
High value of sixth additional range for tag match
- outer-tag-type: string
-
Whether to match all unmatched packets, untagged packets or tagged packets, and if matching tagged packets, the outer tag type to match
- additional-range5-low: string
-
Low value of fifth additional range for tag match
- additional-range2-high: string
-
High value of second additional range for tag match
- exact: null
-
Only match packets with no more tags than explicitly matched
- additional-range4-low: string
-
Low value of forth additional range for tag match
- additional-range1-high: string
-
High value of first additional range for tag match
Example
{
"ingress-destination-mac": "string",
"additional-range4-high": "string",
"additional-range1-low": "string",
"inner-range1-high": "string",
"additional-range8-high": "string",
"additional-range6-low": "string",
"outer-range1-low": "string",
"inner-tag-type": "string",
"additional-range3-low": "string",
"inner-class-of-service": "string",
"additional-range8-low": "string",
"payload-ethertype-match": "string",
"additional-range2-low": "string",
"inner-range1-low": "string",
"additional-range7-high": "string",
"outer-class-of-service": "string",
"additional-range3-high": "string",
"ingress-source-mac": "string",
"outer-range1-high": "string",
"additional-range7-low": "string",
"additional-range5-high": "string",
"additional-range6-high": "string",
"outer-tag-type": "string",
"additional-range5-low": "string",
"additional-range2-high": "string",
"exact": [ null ],
"additional-range4-low": "string",
"additional-range1-high": "string"
}
a3_mac-accounting_schema:
MAC Accounting Configuration
- ingress: null
-
Per MAC address accounting statistics
- egress: null
-
Per MAC address accounting statistics
Example
{
"ingress": [ null ],
"egress": [ null ]
}
a3_carrier-delay_schema:
Set the carrier transition delay on an interface in msecs
- carrier-delay-up: integer
-
Carrier Delay (up) in msecs
range:"1..65535" - carrier-delay-down: integer
-
Carrier Delay down in msecs, must be set to 0
Example
{
"carrier-delay-up": "integer",
"carrier-delay-down": "integer"
}
a3_vlan-trunk-configuration_schema:
IEEE 802.1Q VLAN trunk interface configuration
- native-vlan-identifier: object
-
The Native VLAN identifier associated with this trunk interface
-
- vlan-type: string
-
Whether this interface is dot1ad or dot1Q
- vlan-identifier: string
-
VLAN identifier
- tunneling-ethertype: string 0x9100, 0x9200
-
The outer ethertype used in Q-in-Q frames. The default value is 0x8100
Example
{
"native-vlan-identifier": {
"vlan-type": "string",
"vlan-identifier": "string"
},
"tunneling-ethertype": "string"
}
a3_native-vlan-identifier_schema:
The Native VLAN identifier associated with this trunk interface
- vlan-type: string
-
Whether this interface is dot1ad or dot1Q
- vlan-identifier: string
-
VLAN identifier
Example
{
"vlan-type": "string",
"vlan-identifier": "string"
}